<html>
<body>
<i>JOID</i> is a Java OpenID library to create both relying parties as well
as identity providers.


<h2>Prerequisites</h2>

<ul>
<li>JDK 1.4 and up. You will need ant 1.5 or higher to build.</li>
<li>Hibernate 3 (and a datasource).</li>
</ul>

<h2>File structure</h2>

<ul>
<li>The <code>build.xml</code> file is the main ant build file.</li> 

<li>The <code>src</code> directory contains all source code (build with
<code>ant build</code>).</li> 

<li>The <code>reports</code> directory contains the unit test report
files (run tests with <code>ant test</code>).</li> 

<li>The <code>test</code> directory contains unit test for all the packages 
described above. You can see a great many JOID use cases in this code.</li> 

<li>The <code>api</code> directory contains the javadoc API output (create
with <code>ant api</code>).</li> 

<li>Finally, the <code>out</code> directory contains the built 
<code>joid.jar</code> and <code>joid.war</code> files.</li> 
</ul>

<h2>Not (yet) implemented</h2>
For completeness, this section describes portions of the 
OpenID 2.0 specification (<a 
href="http://openid.net/specs/openid-authentication-2_0-11.html">current 
draft 11</a>) that are not implemented:

<ul>

<li><a href="http://openid.net/specs/openid-authentication-2_0-11.html#anchor12">7. Initiation and Discovery</a>
<ul>
<li>XRI URLs are not supported.</li>
</ul>
</li>

<li><a href="http://openid.net/specs/openid-authentication-2_0-11.html#anchor20">8.2. Association Session Response</a>
<ul>
<li>Clear-text MAC keys are not supported; the key is always encrypted.</li>
</ul>
</li>

</body>
</html>






